home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / door / links32.zip / GOLF.DOC < prev    next >
Text File  |  1992-11-11  |  19KB  |  471 lines
  1. ╔═════════════════════════════════════════════════════════════════════════════╗
  2. ║                                                                             ║
  3. ║                 Corporate Headquarters BBS (815) 886-3233                   ║
  4. ║                                            (815) 886-9381                   ║
  5. ║                                                                             ║
  6. ║          T H E   L I N K S   C O U N T R Y   C L U B   G O L F              ║
  7. ║                                    v3.2                                     ║
  8. ║                                                                             ║
  9. ║                              MULTI-BBS Support                              ║
  10. ║       Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire, WWIV,        ║
  11. ║                UltraBBS, Telegard, TriTel, and Remote Access                ║
  12. ║                                                                             ║
  13. ║                               Copyright 1992                                ║
  14. ║                               by Robert Neal                                ║
  15. ║                             317 Hickory Avenue                              ║
  16. ║                            Romeoville, IL  60441                            ║
  17. ║                                                                             ║
  18. ╚═════════════════════════════════════════════════════════════════════════════╝
  19.  
  20. |Changes to this documentation file from the previous version are
  21. |indicated by "|" in the left hand margin. This should make finding
  22. |changes to the documentation much easier and faster for those upgrading
  23. |from previous versions.
  24.  
  25. |ATTENTION: Beginning with v3.0, the program incorporates new routines.
  26. |Those upgrading from a prior release should note the new format for the
  27. |configuration file. With these changes, the file BRUN45.EXE is no longer
  28. |needed.
  29.  
  30. The Links Country Club Golf (Links) is released as SHAREWARE. You are granted
  31. a limited license to evaluate the program. Try it out, if you continue to use 
  32. it you are required to register the program.
  33.  
  34. ============================================================================
  35. To register the program print the file MAILER.TXT and complete the
  36. information requested.
  37. ============================================================================
  38.  
  39. Links is a golfing simulation game, with either 9 or 18 holes offered
  40. for play. Users golf by making their club selection, woods, irons,
  41. wedges and putter. Yardage is determined by a set standard plus a random
  42. variable to keep the game interesting.
  43.  
  44. The file GOLF.REG contained with this package must not be altered in
  45. anyway. Doing so will result in the program failing to operate. Once you
  46. register the program you will be given your own personalized GOLF.REG
  47. file which will show that the program is registered. BBS name supplied
  48. with payment will be the name 'imprinted' in the GOLF.REG file.
  49.  
  50. THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT
  51. CHARGE AND WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING
  52. BUT NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  53. FOR A PARTICULAR PURPOSE.  IN NO EVENT SHALL ANYONE INVOLVED WITH THE
  54. CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT, SPECIAL,
  55. OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF OR BREACH OF
  56. ANY WARRANTY.
  57.  
  58.  
  59.  
  60. FEATURES OF THE LINKS COUTNRY CLUB GOLF
  61. =======================================
  62.  
  63.   -  Ansi color support.
  64.  
  65.   -  Terminates cleanly through exit code even on runtime error.
  66.  
  67.   -  Automatically creates a top score listing suitable for inclusion
  68.      as a text/bulletin file for display within your BBS. 
  69.  
  70.   -  Detects loss of carrier.
  71.  
  72.   -  Operates in local mode (either direct from BBS or from command line).
  73.  
  74.   -  Sysop function keys to return to the board, chat mode, user stats,
  75.      increase/decrease time, etc.
  76.  
  77.   -  Direct support for PCBoard, WildCat!, Gap, QBBS, RBBS, WWIV,
  78.      Ultra BBS, Telegard, TriTel and Remote Access.
  79.  
  80.   -  Support for baud rates up to 115,200
  81.  
  82.   -  Support for COM1-4. Optional command line for non-standard IRQ's.
  83.  
  84.   -  Supports PCBoard environment variables %PCBDRIVE% and %PCBDIR%
  85.  
  86. | -  Support Fossil Drivers.
  87.  
  88.   -  Fully Multi-Node compatible.
  89.  
  90.   -  Course editor (LINKARCH) added to customize the course layout.
  91.      For REGISTERED versions only.
  92.  
  93. | -  Optional automated monthly rollover maintenance.
  94.  
  95.  
  96.  
  97. THE CONFIG FILE
  98. ================
  99.  
  100. Make the file GOLF.CFG as follows
  101.  
  102. C:\PCB\PCBOARD.SYS
  103. Corporate Headquarters
  104. Bob
  105. Neal
  106.  
  107. Line 1 = Full pathname of your door file. Formats supported by this
  108.          program are: PCBOARD.SYS, USERS.SYS, DOOR.SYS, USERINFO.DAT,
  109.                       CALLINFO.BBS, DORINFOx.DEF, SFDOORS.DAT and
  110.                       CHAIN.TXT. When using USERINFO.DAT, DOOR.SYS
  111.                       must be in the same directory as USERINFO.DAT.
  112. Line 2 = BBS name
  113. Line 3 = Sysop First Name
  114. Line 4 = Sysop Last Name
  115.  
  116. Note: This door supports the PCBoard environment variables %PCBDRIVE%
  117. and %PCBDIR%. Non-PCBoard systems may also use these variables by
  118. including the following either in your BBS batch or AUTOEXEC.BAT file:
  119.  
  120.     SET PCBDRIVE=C:            <- Drive letter of your BBS files
  121.     SET PCBDIR=\BBS            <- Path of your BBS files
  122.  
  123. Then, in your GOLF.CFG file, on the first line you may put:
  124.  
  125.    %PCBDRIVE%%PCBDIR%\PCBOARD.SYS, %PCBDRIVE%%PCBDIR%\DOOR.SYS, etc.
  126.  
  127. This allows you to use just one .CFG file for multi-node operation.
  128.  
  129.  
  130.  
  131. EXECUTING PROGRAM
  132. =================
  133.  
  134. To execute the program, enter the filename followed by the config file
  135. name (ie GOLF GOLF.CFG). If you are running the program from the command
  136. line, you may optionally enter GOLF.EXE LOCAL. The only problem with this is
  137. the default user name sysop is used instead of the username on your board.
  138. This is good for testing the game before putting it on your system, but
  139. you should once play begins execute the program locally from your BBS or
  140. consistantly run the game from the command line when you play.
  141.  
  142. This documentation will not go into the details of how you set-up a door
  143. program on your BBS. It is assumed that you have a working knowledge of
  144. how to complete this task.
  145.  
  146. You may also specify a non-standard IRQ. Put the IRQ number after the
  147. .CFG on the command line. For example: GOLF GOLF.CFG /5. This example tells
  148. the program to use IRQ 5 instead of the standard IRQ.
  149.  
  150. You may also use the procedure above and create a variable IRQ so that
  151. you can pass the IRQ setting as: GOLF GOLF.CFG /%IRQ%.
  152.  
  153. |Some users may have had conflicts when using non-standard IRQ's on
  154. |Novell/Netware systems. Novell seems to use the "/" character for
  155. |parameter passing. You may not optionally use the "*" character instead
  156. |of the "/", for example GOLF GOLF.CFG *%IRQ% is valid. Both "*" and "/"
  157. |will work.
  158.  
  159.  
  160. |FOSSIL DRIVER
  161. |=============
  162. |
  163. |Links Golf now includes support for FOSSIL drivers. This means that the
  164. |program will now work with Digiboard (for Wildcat M and PCBoard/M
  165. |versions) and other multi-port boards. To activate the Fossil driver
  166. |support just include /FD on the command line in your door batch file.
  167. |
  168. |        For example: GOLF GOLF.CFG /FD
  169. |
  170. |If no Fossil driver is available, Links Golf will display a message
  171. |indicating such and exit cleanly.
  172.  
  173.  
  174.  
  175. FILES USED
  176. ===========
  177.  
  178. GOLF.EXE  - The program itself
  179. GOLF.DOC  - Documentation for the sysop to run The Links
  180. GOLF.REG  - File which shows who 'owns' (registered) the game
  181.             MUST NOT BE ALTERED
  182. GOLF.CFG  - Configuration file
  183. GOLF.FIL  - Best scores file (top 5)
  184. GOLF.CRS  - Data file of the course. New to version 2.0 is the option to
  185.             alter the course layout by using the program LINKARCH. 
  186.             NON-REGISTERED users may NOT alter the course. The file
  187.             LINKARCH has been included for you to see how easy it is to
  188.             modify the course to your own personal layout. If you are
  189.             using a NON-REGISTERED version DO NOT alter the course, either
  190.             with a text editor or the LINKARCH program. Doing so will 
  191.             result in the game failing to load.
  192. GOLF.LOG  - This file is created when the program is run. This file will
  193.             contain a synopsis of activity in the door, who played,
  194.             number of holes played and even if they got a whole in one.
  195.  
  196.  
  197. REINITIALIZING THE SCOREBOARD
  198. =============================
  199.  
  200. Every so often you may want to reset the scoreboard (especially when you
  201. have the scoreboard filled with LOW scores that would be difficult or
  202. impossible to better). To reset the scoreboard enter GOLF INIT and the
  203. game will automatically reinitialize the scoreboard. You may also copy 
  204. over the original unmodified scoreboard included in this archive to 
  205. esentially reset the game.
  206.  
  207.  
  208. |MONTHLY ROLLOVER MAINTENANCE
  209. |============================
  210. |
  211. |You may optionally have Links Golf automatically rollover the scoreboard
  212. |on a monthly basis by entering GOLF MAINTxx (where xx is the day of the
  213. |month you want to rollover the scoreboard). For example, to reset your
  214. |scoreboard on the first of each month, enter GOLF MAINT1. To reset on
  215. |the 15th, enter GOLF MAINT15. This command should be run as part of your
  216. |BBS nightly event processing. If maintenance is not required, the
  217. |program will exit cleanly. If maintenance is required, the program
  218. |will automatically reset the scoreboard information.
  219.  
  220.                 
  221.  
  222.  
  223. THE GAME ITSELF
  224. ===============
  225.  
  226. The game starts by displaying The Links opening screen (please do not
  227. modify this or any other part of the game), and will ask the user if he 
  228. wants to use ANSI colors. While the door info file passes the variable for
  229. if a user has ANSI on or off, this gives those players a chance who may have
  230. ANSI off for normal BBS useage to use ANSI colors while in the door.
  231.  
  232. From here he is asked if he wants to play 9 or 18 holes. If he selects 9
  233. holes he is then asked if he wishes to play the front 9 or back 9. He is
  234. then asked if he wishes to read the instructions on how to play The Links.
  235.  
  236. When prompted for club selection entering QUIT (or 'Q') will terminate
  237. play. Entering HELP (or 'H') will display a listing of available clubs
  238. and approximate distances.
  239.  
  240. After the user has played all 9 or 18 holes his ranking is shown if he
  241. beats one of the top 5 scores. The best score file is then updated and
  242. the program terminates returning to the BBS.
  243.  
  244. SYSOP KEYS ACTIVE
  245.  
  246. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  247.          written to DOOR.SYS and USERS.SYS
  248. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  249.          and/or written to DOOR.SYS and USERS.SYS
  250. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  251. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  252.          and/or written to DOOR.SYS and USERS.SYS
  253. F8    -  Returns the caller involuntarily to the BBS.
  254. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  255.          and/or written to DOOR.SYS and USERS.SYS
  256. F10   -  Activates SysOp CHAT mode within the DOOR.
  257. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  258. UP    -  Give the caller extra time while in the DOOR.  
  259. DN    -  Subtract time from the caller while in the DOOR. 
  260. HOME  -  HELP key for Status Line options.
  261. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  262. ALT-X -  PCBoard will exit after current caller logs off. Value is
  263.          passed to PCBoard. Not available on non-PCBoard systems.
  264.  
  265.  
  266.  
  267.  
  268.  
  269. THE LINKS COURSE EDITOR (LINKARCH.EXE)
  270. ======================================
  271.  
  272. The file GOLF.CRS contains the information concerning the course layout
  273. and MUST be edited using LINKARCH. Attempts to edit the program with a
  274. text editor will result in the game failing to execute. 
  275.  
  276. The course editor should only be used by REGISTERED users of The Links
  277. Country Club Golf. NON-REGISTERED versions will fail to execute if the
  278. orignal GOLF.CRS file is edited in anyway.
  279.  
  280. The LINKARCH file is contained in this archived file so that previously
  281. registered users have the file available without needing to request it 
  282. and also so that NON-REGISTERED users can see how easy it is to edit
  283. the course, though any changes made will not be saved.
  284.  
  285. When using the course editor you should be certain to keep the par
  286. for the front and back nine the same. As a rule of thumb, distances
  287. less than 250 yards should be a par 3, 250-375 a par 4 and anything over
  288. 375 yards should be set as par 5. 
  289.  
  290.  
  291.  
  292. CONTACT ME FOR SUPPORT
  293. ======================
  294.  
  295. If you encounter any problem you may contact me at Corporate Headquarters
  296. |BBS (815) 886-3233 or (815) 886-9381 (v.32 bis 1200-14400).
  297. This is a PCPursuitable area through the ILCHI area. This program has
  298. been run extensively on my system and through the years on the systems
  299. of many who have registered (and probably more who haven't registered)
  300. this program. I feel confident that the program will perform as planned.
  301. If you do encounter any bugs (or features as some might call them),
  302. please inform me of the problem so that future releases can be
  303. corrected.
  304.  
  305. In addition to my BBS, I also hang around the SYSOPS, DOORS and BBS
  306. SOFTWARE message conferences on the RIME network. You can send me
  307. messages via this network.
  308.  
  309. If you have any suggestions for improvements for this program, please feel
  310. free to let me know. This game has included suggestions from users of my
  311. BBS as well as the beta testing BBS. 
  312.  
  313.  
  314.  
  315. VERSION HISTORY
  316. ===============
  317.  
  318. Version 1.0 (03/23/89)
  319.  
  320. Initial release of The Links. 
  321.  
  322.  
  323.  
  324. Version 1.1 (04/15/89)
  325.  
  326. Scoreboard was being written to one filename and read from another. Fixed
  327. this error to now read and write to the same filename.
  328.  
  329.  
  330. Version 2.0 (11/24/89)
  331.  
  332. Fixed bug with a hole in one shot. In previous versions the user was not
  333. accessed a stroke for that hole, this has now been corrected to access the
  334. one stroke used.
  335.  
  336. Added support for MULTI-BBS usage. Links now has direct support for
  337. PCBoard 14.x, QBBS and Wildcat BBS.
  338.  
  339. Added option to run as STAND ALONE (non-bbs). Type GOLF.EXE NOBBS.
  340.  
  341. Added HELP function. User can now enter HELP when asked for club selection
  342. and a listing of the clubs and approximate yardage is shown.
  343.  
  344. Adjusted the distance of each club slightly, especially the SAND WEDGE.
  345. Found in the previous versions the SAND WEDGE would nearly guarantee that
  346. the player would end up 1 yard from the hole. 
  347.  
  348. Wrote LINKARCH which will allow you to customize your courses. This feature
  349. is ONLY available to REGISTERED users of the program. Attempting to alter
  350. the course for a non-registered version will result in the game failing
  351. to execute.
  352.  
  353.  
  354. Version 2.1 - 2.2 (Added support for other BBS programs, WWIV and Spitfire)
  355.  
  356.  
  357. Version 2.3 (08/13/90)
  358.  
  359. Limited release version for beta testing new routines for high speed HST
  360. modems.
  361.  
  362.  
  363. Version 2.4 (08/21/90)
  364.  
  365. Resolved problem with high speed modems (9600+ baud). Beta testers have
  366. reported that program now operates fine at high speed modes.
  367.  
  368. Changed compiler to latest version, v4.5 of Quick Basic. Program now
  369. requires use of patch BRUN45.EXE program. Program is distributed with
  370. this program.
  371.  
  372. Added selection QUIT to listing of available clubs.
  373.  
  374.  
  375. Version 2.5 (05/21/92)
  376.  
  377. Wow - has it really been 2 years since I've had the need to upgrade this
  378. program? Guess it has been. I guess that speaks highly that the code is
  379. stable. Been hunting for new ideas on what to add, if you have any,
  380. please write.
  381.  
  382. Main changes this version are that it seems several authors have decided
  383. to expand their door format files. The conversion routines for
  384. DORINFOx.DEF and SFDOORS.DEF file have been modified in this version to
  385. allow Links to operate with the expanded formats.
  386.  
  387. While I was in the code, added log file to the door. I've held several
  388. golf tournaments on my board and know of several other BBS's who have
  389. done so as well. This option should allow you to see at a glance, who's
  390. played, their score and if they've hit a whole in one. Straight ascii
  391. text file.
  392.  
  393. Also, a scoreboard has now been added. If you are upgrading from a prior
  394. version, type GOLF UPGRADE while in the directory that this program is in.
  395. This will read your scoreboard data file and create the text file,
  396. suitable for displaying in a bulletin.
  397.  
  398. Version 2.6 (06/29/92)
  399.  
  400. Wouldn't you know it? When I installed the new scoreboard routines I
  401. forgot to document in this file how to initialize the game. Rather than
  402. just update the doc file, I made the program bullet proof by letting the
  403. program check if it needs to initialize the files, and if so, it now
  404. does the initialization automatically.
  405.  
  406. I also took care of some other minor changes in the program, giving
  407. defaults to some additional prompts, etc. From now on I'll have to beta
  408. test my documentation along with the actual program.
  409.  
  410. Also redid the log file to make it display in a single line ascii file.
  411. This layout is easier to read at a glance.
  412.  
  413.  
  414. Version 2.7 (08/05/92)
  415.  
  416. Minor upgrade - Seems somewhere along the line the RBBS DORINFOx.DEF
  417. format was changed as I had a user report a problem with operating the
  418. door locally. Revised I/O routines to adjust for difference in format to
  419. allow local play. Thanks to Rob Engle for assisting with this problem.
  420.  
  421. v3.0 (08/23/92)
  422.  
  423. Underwent a major upgrade in the I/O routines. This door now supports baud
  424. rates up to 115,200 and COM1-4 (plus non-standard IRQ's). This should help
  425. those who lock their baud rates at 38,400 and above. In addition, these new
  426. routines should allow the program to be run under DesqView. Please note, those
  427. who are upgrading from a prior version should review the new configuration
  428. file format. This door is now released as a completely stand-alone
  429. program, no longer requiring the BRUN45.EXE file.
  430.  
  431.  
  432. v3.1 (10/18/92)
  433.  
  434. Improved screen I/O routines, faster displays
  435.  
  436. Improved CHAT function - now restores screen upon return
  437.  
  438. Fixed problem with UPPER case input - both upper and lower case is now
  439. fully supported
  440.  
  441.  
  442. v3.1a (10/22/92)
  443.  
  444. Due to an error, the v3.1 package was distributed with the v3.0 GOLF.EXE
  445. file. Corrected this error. No other changes to the distributed package.
  446.  
  447.  
  448. |v3.2 (11/11/92)
  449. |
  450. |New MAINT option available to automatically rollover the scoreboard
  451. |information each month (see section MONTHLY ROLLOVER MAINTENANCE above
  452. |for details).
  453. |
  454. |New support for FOSSIL drivers (see section on FOSSIL DRIVERS above for
  455. |details).
  456. |
  457. |Screen displays have again been optimized, screen displays are faster
  458. |than previous versions.
  459.  
  460.  
  461.  
  462. DISTRIBUTION SITES:
  463.  
  464.    As always you can find the latest version of Links available for
  465.    downloading from Corporate Headquarters BBS.
  466.  
  467.    Corporate Headquarters BBS  Node #1 (815)886-3233 (1200-14400 v.32bis)
  468.                                Node #2 (815)886-9381 (1200-14400 v.32bis)
  469.  
  470.    TDS Network                         (503) 342-4447 (HST 14.4)
  471.